fix: correct docs for contact-summary field appliesIf
#1718
Conversation
|
@kennsippell when you have a second, can you just confirm this passes your smell test? 🙏 cc @tatilepizs |
| @@ -55,7 +55,7 @@ Each field that can be shown on a contact's profile is defined as an object in t | |||
| | `width` | `integer` | The horizontal space for the field. Common values are 12 for full width, 6 for half width, or 3 for quarter width. Default 12. | no | | |||
| | `translate` | `boolean` | Whether or not to translate the `value`. Defaults to false. | no | | |||
| | `context` | `object` | When `translate: true` and `value` uses [translation variables](https://angular-translate.github.io/docs/#/guide/06_variable-replacement), this value should provide the translation variables. | no | | |||
| | `appliesIf` | `function()` or `boolean` | Return true if the field should be shown. | no | | |||
| | `appliesIf` | `function()` | Return `true` if the field should be shown, and `false` if it should be hidden. Default is `true`. | no | | |||
There was a problem hiding this comment.
I dunno how much detail to go into. Smells fine but slightly incomplete... it's a bit more complicated than saying "false if hidden" because visibility is determined by appliesIf && !resolvedIf. I think this is explained somewhat well here.
There was a problem hiding this comment.
Thanks for having a look!
visibility is determined by appliesIf && !resolvedIf
These docs are specifically for the contact-summary fields. Unless I am totally missing something, I think that resolvedIf is just for tasks. In the tasks world, yes, visibility (and everything else 😅) is more complicated, but here for the contact summary fields, I think the logic is more straight forward.
That being said, if I totally misunderstood what you meant, let me know and I can open a new PR to better clarify things!
Description
Currently the contact-summary
fieldsdocs indicate that theappliesIfproperty for a field could be:However, checking the actual code in cht-conf, there is no way that a
booleanvalue could be set here with a semantically logical meaning.If you set
appliesIf = false, this if-statement would resolvetruebecause!false === true. If you setappliesIf = true, then we get the errorTypeError: f.appliesIf is not a functionbecause it will try to callappliesIfas a function when the property exists.This PR simply updates the docs to clarify that
appliesIfcan only be a function.License
The software is provided under AGPL-3.0. Contributions to this project are accepted under the same license.